home *** CD-ROM | disk | FTP | other *** search
/ Beginning Mac Programming / Beginning Mac Programming.bin / pc / Open Me for REALbasic 3 / REALbasic 3.2 / Goodies / 3rd Party Demos / 3rd Party Plugins / Misc / PEVocoder 1.0 (PPC) / PEVocoder README next >
Encoding:
Text File  |  2000-11-22  |  3.5 KB  |  74 lines

  1. PEVocoder 1.0
  2. Purple E Software ©2000
  3. http://homepage.mac.com/etejkowski/dl.htm
  4. <etejkowski@home.com>
  5.  
  6. PEVocoder is based on open source code from the Zerius Vocoder 1.2 by Emanuel Borsboom. You can download information,original C source code, and command line versions for a variety of platforms from Zerius:
  7. http://zerius.com/vocoder/
  8. ftp://ftp.zerius.com/pub/zerius/vocoder/
  9.  
  10. PEVocoder 1.0 is a REALbasic plugin that provides vocoding capabilties through one global Method:
  11. ************************
  12. The Method:
  13. ************************
  14. PEVocode
  15. (
  16.     modulatorpath as string, 
  17.     carrierpath as string,
  18.     targetpath as string, 
  19.     windowlength as integer, 
  20.     windowoverlap as integer, 
  21.     bandcount as integer 
  22. as Integer
  23.  
  24. ************************
  25. The Parameters:
  26. ************************
  27.  
  28. modulatorpath as string - the file path for the sound file to be used as the modulator. For example, use m.absolutepath, where m is a REALbasic FolderItem representing the modulator audio file. The modulator sound file must be MONO, 8- or 16-bit linear, uncompressed AIFF or WAVE file.  
  29.  
  30. carrierpath as string - the file path for the sound file to be used as the carrier. For example, use c.absolutepath, where c is a REALbasic FolderItem representing the carrier sound file. The carrier sound file must be MONO, 8- or 16-bit linear, uncompressed AIFF or WAVE file.  
  31.  
  32. targetpath as string - the file path for the resulting sound file you wish to create. For example, use t.absolutepath, where t is a REALbasic FolderItem representing the target sound file. The resulting sound file will have the same file type as the modulator (regardless of the file extension you give it).
  33.  
  34. windowlength as integer -     the number of samples that will be analyzed at a time, and must be a power of two (defaults to about 1/15th of a second worth of
  35.     samples). If you pass it a value of -1, the plugin will use the default value. (Recommended, if you don't know what you're doing.)
  36.  
  37. windowoverlap as integer - the number of samples that the windows will be overlapped    (defaults to one half of the window-length). If you pass it a value of -1, the plugin will use the default value. (Recommended, if you don't know what you're doing.)
  38.  
  39. bandcount as integer - the number of frequency bands that the carrier will be modulated with (defaults to 16). If you pass it a value of -1, the plugin will use the default value. (Recommended, if you don't know what you're doing.)
  40.  
  41. ************************
  42. The Return value:
  43. ************************
  44.  
  45. PEVocode returns an integer upon completion. If the vocoding operation is successful, the Method returns a value of 1. If there is an error during processing, PEVocode returns one of the following error codes:
  46.  
  47. ERROR Code:                What it means:
  48. -10                                            winlength must be >1 and also a power of 2 [e.g. 128,256,512,1024,etc...]
  49. -11                                            winoverlap must be >=0 and <=(winlength/2)
  50. -12                                            bandcount must be >0 and <=(winlength/2)
  51. -13                                            carrier audio file must only have 1 channel (Mono)
  52. -14                                            modulator audio file must only have 1 channel (Mono)
  53.  
  54. ---------
  55. Copyright
  56. ---------
  57.  
  58. The Zerius Vocoder is Copyright (C) 1996-1998 Emanuel Borsboom.
  59. SampleModulator.aif and SampleCarrier.aif sound files courtesy Emanuel Borsboom.
  60.  
  61. The FFT code (contained in fftn.c, fftaux.c, fft.h, and spt.h) is
  62. Copyright (C) 1993 Steven Trainoff.
  63.  
  64. The code for converting to and from IEEE floating-point numbers is
  65. Copyright (C) 1988-1991 Apple Computer Inc.
  66.  
  67. You are free to do whatever you like with the vocoder, as long as the
  68. copyright notice stays intact and you note any changes.
  69.  
  70. There is no warranty.
  71.  
  72.  
  73.